<!DOCTYPE html>
<html lang="en">
<head>
<title>Workplan</title>

<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../../css/bootstrap.min.css">
<link rel="stylesheet" href="../../css/custom.css">
</head>

<body>

<div class="container">
<nav class="navbar">
<a class="btn btn-info btn-xs navbar-btn pull-right m-l" href="../index.html">REST API</a>
<a class="btn btn-info btn-xs navbar-btn pull-right" href="../../index.html">Back to Docs</a>
</nav>

<h1>Workplan</h1>
<p><code>/v3/nc/workplan[/{id}]</code></p>
<p>Defined in <a href="https://github.com/steptools/NC.js/blob/master/src/server/api/v3/step.js">step.js</a></p>

<p>The workplan API endpoint returns information about the STEP-NC
process held by the digital thread.  The process is composed of a
nested series of executable objects.  A workingstep describes a single
machining operation with some toolpaths.  Workplans contain a sequence
of executables.  Some workplans have a setup transform to describe a
fixturing of the part.  Selectives contain a set of alternative
executables.

<H2>Get Complete Main Workplan</H2>

<PRE>GET /v3/nc/workplan</PRE>

<p>GET on the Workplan root endpoint returns the main workplan of a
STEP-NC process containing a tree of nested executable objects.  The
main workplan and nested workingsteps are described
by <a href="workplan_object.html">executable objects</a>.</p>



<H2>Get Individual Executable</H2>

<PRE>GET /v3/nc/workplan/{id}</PRE>

<p>GET with a numeric id will return the description of a single
executable.  The return value is
an <a href="workplan_object.html">executable object</a>.  You request
a workplan or selective, the return value will contain all of the
nested children objects.

</p>


<script src="../../js/jquery.min.js"></script>
<script src="../../js/bootstrap.min.js"></script>
</body>
</html>
